<html dir="ltr">
	<head>
		<title>Documentating Namespaces</title>
		<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
		<meta content="http://schemas.microsoft.com/intellisense/ie5" name="vs_targetSchema">
		<xml></xml><LINK href="MSDN.css" type="text/css" rel="stylesheet">
		<script language="javascript">
		function openNewWindow(strUrl){window.open(strUrl, '_blank');} // Open the given url in a new window
		</script>
	</head>
	<body class="dtBODY" id="bodyID">
		<div id="nsbanner">
			<div id="bannerrow1">
				<table class="bannerparthead" id="Table1" cellSpacing="0">
					<tr id="hdr">
						<td class="runninghead">NDocBuilder Documentation</td>
						<td class="product"></td>
					</tr>
				</table>
			</div>
			<div id="TitleRow">
				<h1 class="dtH1">NDocBuilder</h1>
			</div>
		</div>
		<div id="nstext">
			<p><h3 class="dtH3">Documentating Namespaces</h3>
				To document a namespace you have to add a special class named <i>NamespaceDoc</i>
				to the project. The text between the summary comments of this class are used as 
				the documentation of the namespace. Follow the following steps to add namespace 
				documentation:<br>
				<ul>
					<li>
						Open the project from section <a href="TestingNDocBuilder.htm">Testing NDocBuilder</a>
					<li>
						Go to the menu "<i>File</i> -&gt; <i>Add New Item ...</i>" and select <i>class</i>.<br>
						Give it the name <i>NamespaceDoc.cs</i> (case sensitive) and press <i>Ok</i>.<br>
						<p><img src="NewClassNamespaceDoc.gif"></p>
					<li>
						Change the text "<i>Summary description for NamespaceDoc</i>" to something 
						else.<br>
						The class definition will look something like this:<br>
						<pre><FONT color=#0000ff>using</FONT> System;

<FONT color=#0000ff>#if</FONT> DEBUG

<FONT color=#0000ff>namespace</FONT> NDocBuilderTestConsoleApp
{
	<FONT color=gray>/// &lt;summary&gt;</FONT>
	<FONT color=gray>/// </FONT><FONT color=green>Lorem ipsum dolor sit amet, consectetuer adipiscing elit.</FONT>
	<FONT color=gray>/// </FONT><FONT color=green>Duis fringilla lobortis erat. Aliquam fringilla euismod nulla.
</FONT>	<FONT color=gray>/// </FONT><FONT color=green>Donec nisl orci, feugiat non, posuere quis, dignissim a, nunc.
</FONT>	<FONT color=gray>/// &lt;/summary&gt;</FONT> 
	<FONT color=#0000ff>public class</FONT> NamespaceDoc
	{
	}
}

<FONT color=#0000ff>#endif</FONT>
</pre>
						Note the "<i>#if DEBUG</i>" and "#endif". This will make sure the class is only compiled in debug mode.
					</li>
					<li>
						If you now recompile the assembly and execute the NDocBuilder plugin again the chm file will now contain namespace documentation.<br/>
					</li>
				</ul>
				
			</p><hr>
			<div id="footer">
				<p>
				</p>
				<p>
				</p>
			</div>
		</div>
	</body>
</html>
